Skip to content

docs: update ImagePart refdocs #6681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 17, 2025
Merged

Conversation

thatfiredev
Copy link
Member

The current refdocs are somewhat confusing and may lead to assume that the conversion happens server-side, when it's actually client side.

@thatfiredev thatfiredev requested a review from rlazo February 7, 2025 12:05
Copy link
Contributor

github-actions bot commented Feb 7, 2025

Javadoc Changes:
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagePart.html	2025-02-17 13:45:08.164930195 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagePart.html	2025-02-17 13:43:00.353474468 +0000
@@ -11,7 +11,7 @@
       <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagePart.html">ImagePart</a> implements <a href="/docs/reference/android/com/google/firebase/vertexai/type/Part.html">Part</a></pre>
     </p>
     <hr>
-    <p>Represents image data sent to and received from requests. When this is sent to the server it is converted to jpeg encoding at 80% quality.</p>
+    <p>Represents image data sent to and received from requests. The image is converted client-side to JPEG encoding at 80% quality before being sent to the server.</p>
     <h2>Summary</h2>
     <div class="devsite-table-wrapper">
       <table class="responsive">
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagePart.html	2025-02-17 13:45:08.173930224 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagePart.html	2025-02-17 13:43:00.360474493 +0000
@@ -11,7 +11,7 @@
       <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagePart.html">ImagePart</a> : <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Part.html">Part</a></pre>
     </p>
     <hr>
-    <p>Represents image data sent to and received from requests. When this is sent to the server it is converted to jpeg encoding at 80% quality.</p>
+    <p>Represents image data sent to and received from requests. The image is converted client-side to JPEG encoding at 80% quality before being sent to the server.</p>
     <h2>Summary</h2>
     <div class="devsite-table-wrapper">
       <table class="responsive">

Copy link
Contributor

github-actions bot commented Feb 7, 2025

Test Results

 20 files  + 12   20 suites  +12   12s ⏱️ -7s
114 tests + 92  114 ✅ + 92  0 💤 ±0  0 ❌ ±0 
228 runs  +184  228 ✅ +184  0 💤 ±0  0 ❌ ±0 

Results for commit 4c504da. ± Comparison against base commit f80ba89.

This pull request removes 22 and adds 114 tests. Note that renamed tests count towards both.
com.google.firebase.crashlytics.internal.common.CrashlyticsControllerRobolectricTest ‑ testDoCloseSession_disabledAnrs_doesNotPersistsAppExitInfo
com.google.firebase.crashlytics.internal.common.CrashlyticsControllerRobolectricTest ‑ testDoCloseSession_enabledAnrs_doesNotPersistsAppExitInfoIfItDoesntExist
com.google.firebase.crashlytics.internal.common.CrashlyticsControllerRobolectricTest ‑ testDoCloseSession_enabledAnrs_persistsAppExitInfoIfItExists
com.google.firebase.crashlytics.internal.common.DataCollectionArbiterRobolectricTest ‑ testDefaultDataCollection_usedWhenNoOverrideOrManifestSetting
com.google.firebase.crashlytics.internal.common.DataCollectionArbiterRobolectricTest ‑ testManifestMetadata_respectedWhenNoOverride
com.google.firebase.crashlytics.internal.common.DataCollectionArbiterRobolectricTest ‑ testSetCrashlyticsDataCollectionEnabled_overridesOtherSettings
com.google.firebase.crashlytics.internal.common.SessionReportingCoordinatorRobolectricTest ‑ testAppExitInfoEvent_notPersistIfAnrBeforeSession
com.google.firebase.crashlytics.internal.common.SessionReportingCoordinatorRobolectricTest ‑ testAppExitInfoEvent_notPersistIfAppExitInfoNotAnrButWithinSession
com.google.firebase.crashlytics.internal.common.SessionReportingCoordinatorRobolectricTest ‑ testAppExitInfoEvent_persistIfAnrWithinSession
com.google.firebase.crashlytics.internal.common.SessionReportingCoordinatorRobolectricTest ‑ testAppExitInfoEvent_persistIfAnrWithinSession_multipleAppExitInfo
…
com.google.firebase.vertexai.GenerativeModelTesting ‑ exception thrown when using invalid location
com.google.firebase.vertexai.GenerativeModelTesting ‑ system calling in request
com.google.firebase.vertexai.SchemaTests ‑ basic schema declaration
com.google.firebase.vertexai.SchemaTests ‑ full schema declaration
com.google.firebase.vertexai.StreamingSnapshotTests ‑ citation parsed correctly
com.google.firebase.vertexai.StreamingSnapshotTests ‑ empty content
com.google.firebase.vertexai.StreamingSnapshotTests ‑ http errors
com.google.firebase.vertexai.StreamingSnapshotTests ‑ image rejected
com.google.firebase.vertexai.StreamingSnapshotTests ‑ invalid api key
com.google.firebase.vertexai.StreamingSnapshotTests ‑ invalid json
…

♻️ This comment has been updated with latest results.

@google-oss-bot
Copy link
Contributor

1 Warning
⚠️ Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 7, 2025

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 7, 2025

@thatfiredev thatfiredev merged commit e125fb7 into main Feb 17, 2025
30 checks passed
@thatfiredev thatfiredev deleted the rpf-update-imagepart-ref-docs branch February 17, 2025 13:57
@firebase firebase locked and limited conversation to collaborators Mar 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants